<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>GZIPSheetDataWriter (POI API Documentation)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="GZIPSheetDataWriter (POI API Documentation)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/GZIPSheetDataWriter.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>PREV CLASS</li>
<li><a href="../../../../../org/apache/poi/xssf/streaming/SheetDataWriter.html" title="class in org.apache.poi.xssf.streaming"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/xssf/streaming/GZIPSheetDataWriter.html" target="_top">FRAMES</a></li>
<li><a href="GZIPSheetDataWriter.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<p class="subTitle">org.apache.poi.xssf.streaming</p>
<h2 title="Class GZIPSheetDataWriter" class="title">Class GZIPSheetDataWriter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/poi/xssf/streaming/SheetDataWriter.html" title="class in org.apache.poi.xssf.streaming">org.apache.poi.xssf.streaming.SheetDataWriter</a></li>
<li>
<ul class="inheritance">
<li>org.apache.poi.xssf.streaming.GZIPSheetDataWriter</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <strong>GZIPSheetDataWriter</strong>
extends <a href="../../../../../org/apache/poi/xssf/streaming/SheetDataWriter.html" title="class in org.apache.poi.xssf.streaming">SheetDataWriter</a></pre>
<div class="block">Sheet writer that supports gzip compression of the temp files.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/xssf/streaming/GZIPSheetDataWriter.html#GZIPSheetDataWriter()">GZIPSheetDataWriter</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/xssf/streaming/GZIPSheetDataWriter.html#GZIPSheetDataWriter(org.apache.poi.xssf.model.SharedStringsTable)">GZIPSheetDataWriter</a></strong>(<a href="../../../../../org/apache/poi/xssf/model/SharedStringsTable.html" title="class in org.apache.poi.xssf.model">SharedStringsTable</a>&nbsp;sharedStringsTable)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.io.File</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/streaming/GZIPSheetDataWriter.html#createTempFile()">createTempFile</a></strong>()</code>
<div class="block">Create a temp file to write sheet data.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.io.Writer</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/streaming/GZIPSheetDataWriter.html#createWriter(java.io.File)">createWriter</a></strong>(java.io.File&nbsp;fd)</code>
<div class="block">Create a writer for the sheet data.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.io.InputStream</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/streaming/GZIPSheetDataWriter.html#getWorksheetXMLInputStream()">getWorksheetXMLInputStream</a></strong>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.xssf.streaming.SheetDataWriter">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.poi.xssf.streaming.<a href="../../../../../org/apache/poi/xssf/streaming/SheetDataWriter.html" title="class in org.apache.poi.xssf.streaming">SheetDataWriter</a></h3>
<code><a href="../../../../../org/apache/poi/xssf/streaming/SheetDataWriter.html#close()">close</a>, <a href="../../../../../org/apache/poi/xssf/streaming/SheetDataWriter.html#finalize()">finalize</a>, <a href="../../../../../org/apache/poi/xssf/streaming/SheetDataWriter.html#getLastFlushedRow()">getLastFlushedRow</a>, <a href="../../../../../org/apache/poi/xssf/streaming/SheetDataWriter.html#getLowestIndexOfFlushedRows()">getLowestIndexOfFlushedRows</a>, <a href="../../../../../org/apache/poi/xssf/streaming/SheetDataWriter.html#getNumberOfCellsOfLastFlushedRow()">getNumberOfCellsOfLastFlushedRow</a>, <a href="../../../../../org/apache/poi/xssf/streaming/SheetDataWriter.html#getNumberOfFlushedRows()">getNumberOfFlushedRows</a>, <a href="../../../../../org/apache/poi/xssf/streaming/SheetDataWriter.html#outputQuotedString(java.lang.String)">outputQuotedString</a>, <a href="../../../../../org/apache/poi/xssf/streaming/SheetDataWriter.html#writeCell(int, org.apache.poi.ss.usermodel.Cell)">writeCell</a>, <a href="../../../../../org/apache/poi/xssf/streaming/SheetDataWriter.html#writeRow(int, org.apache.poi.xssf.streaming.SXSSFRow)">writeRow</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="GZIPSheetDataWriter()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GZIPSheetDataWriter</h4>
<pre>public&nbsp;GZIPSheetDataWriter()
                    throws java.io.IOException</pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="GZIPSheetDataWriter(org.apache.poi.xssf.model.SharedStringsTable)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>GZIPSheetDataWriter</h4>
<pre>public&nbsp;GZIPSheetDataWriter(<a href="../../../../../org/apache/poi/xssf/model/SharedStringsTable.html" title="class in org.apache.poi.xssf.model">SharedStringsTable</a>&nbsp;sharedStringsTable)
                    throws java.io.IOException</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sharedStringsTable</code> - the shared strings table, or null if inline text is used</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="createTempFile()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTempFile</h4>
<pre>public&nbsp;java.io.File&nbsp;createTempFile()
                            throws java.io.IOException</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../org/apache/poi/xssf/streaming/SheetDataWriter.html#createTempFile()">SheetDataWriter</a></code></strong></div>
<div class="block">Create a temp file to write sheet data. 
 By default, temp files are created in the default temporary-file directory
 with a prefix "poi-sxssf-sheet" and suffix ".xml".  Subclasses can override 
 it and specify a different temp directory or filename or suffix, e.g. <code>.gz</code></div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/xssf/streaming/SheetDataWriter.html#createTempFile()">createTempFile</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/poi/xssf/streaming/SheetDataWriter.html" title="class in org.apache.poi.xssf.streaming">SheetDataWriter</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>temp file to write sheet data</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="createWriter(java.io.File)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createWriter</h4>
<pre>public&nbsp;java.io.Writer&nbsp;createWriter(java.io.File&nbsp;fd)
                            throws java.io.IOException</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../org/apache/poi/xssf/streaming/SheetDataWriter.html#createWriter(java.io.File)">SheetDataWriter</a></code></strong></div>
<div class="block">Create a writer for the sheet data.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/xssf/streaming/SheetDataWriter.html#createWriter(java.io.File)">createWriter</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/poi/xssf/streaming/SheetDataWriter.html" title="class in org.apache.poi.xssf.streaming">SheetDataWriter</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>fd</code> - the file to write to</dd>
<dt><span class="strong">Returns:</span></dt><dd>a wrapped instance of GZIPOutputStream</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="getWorksheetXMLInputStream()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getWorksheetXMLInputStream</h4>
<pre>public&nbsp;java.io.InputStream&nbsp;getWorksheetXMLInputStream()
                                               throws java.io.IOException</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/xssf/streaming/SheetDataWriter.html#getWorksheetXMLInputStream()">getWorksheetXMLInputStream</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/poi/xssf/streaming/SheetDataWriter.html" title="class in org.apache.poi.xssf.streaming">SheetDataWriter</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a GZIPInputStream stream to read the compressed temp file</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/GZIPSheetDataWriter.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>PREV CLASS</li>
<li><a href="../../../../../org/apache/poi/xssf/streaming/SheetDataWriter.html" title="class in org.apache.poi.xssf.streaming"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/xssf/streaming/GZIPSheetDataWriter.html" target="_top">FRAMES</a></li>
<li><a href="GZIPSheetDataWriter.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
                <i>Copyright 2014 The Apache Software Foundation or
        its licensors, as applicable.</i>
            </small></p>
</body>
</html>
